emida-ux

1.0.x
(0 reviews)

Retrieve Plans

/productOffering

#[GET]

This operation retrieves available plans and addOns based on given criteria.

URL
https://[host]:[port]/emida-ux/v1/{businessId}/productOffering
URI Params
nametypedescriptionrequired
businessIdstringDefault CR for Costa RicaY
Headers
nametypedescriptionrequired
client_idstringThe client_id identifying the channel. Minimum characters: 5Y
client_secretstringPassword associated with the client_id. Minimum characters: 5Y
X-Correlation-IDstringIdentifier that correlates HTTP request between a client and server.
Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction.		Y
Query Param
nametypedescriptionrequired
category.nameStringExpected values are: Plan, DataPlan and AddOnY
Request
curl --location 'https://nonprod.lcr.esb.cloud.lla.com/test/emida-ux-lcr/emida-ux/v1/CR/productOffering?category.name=DataPlan' \
--header 'client_id: *********' \
--header 'client_secret: *********' \
--header 'X-Correlation-ID: {{$guid}}'
Response
[
  {
    "id": "PO_1001",
    "name": "Unlimited Data Plan 28 Days",
    "description": "High speed data plan with voice and SMS",
    "lifecycleStatus": "Active",
    "category": [
      {
        "id": "0",
        "name": "DataPlan",
        "@type": "CategoryRef"
      }
    ],
    "productOfferingPrice": [
      {
        "name": "Product Price",
        "price": {
          "taxIncludedAmount": {
            "value": 299,
            "unit": "USD"
          }
        }
      }
    ],
    "prodSpecCharValueUse": [
      {
        "name": "dataAmount",
        "valueType": "string",
        "productSpecCharacteristicValue": [
          {
            "value": "20GB"
          }
        ]
      },
      {
        "name": "voiceMinutes",
        "valueType": "number",
        "productSpecCharacteristicValue": [
          {
            "value": 100
          }
        ]
      },
      {
        "name": "activationKeyword",
        "valueType": "string",
        "productSpecCharacteristicValue": [
          {
            "value": "COLD10GB"
          }
        ]
      },
      {
        "name": "smsCount",
        "valueType": "number",
        "productSpecCharacteristicValue": [
          {
            "value": 100
          }
        ]
      },
      {
        "name": "validityDays",
        "valueType": "number",
        "productSpecCharacteristicValue": [
          {
            "value": 28
          }
        ]
      }
    ]
  }
]

Reviews